/*
 * @Author: 0x9DEFA478
 * @Date: 2024-08-04 13:23:52
 * @LastEditTime: 2024-08-10 17:24:09
 * @LastEditors: 0x9DEFA478
 * @Description: 
 * QQ:2652450237
 * ============================================================================================================================================
 * 
 * 
 * 
 *                                                                                               ************      ****************************
 *                                                                                             ************      ****************************  
 *                                                                                           ************      ****************************    
 *                                                                                         ************      ****************************      
 *                                                                                       ************      ************                        
 *                                                                                     ************      ************                          
 *                                                                                   ************      ************                            
 *                                                                                 ************      ************                              
 *                                                                               ************      ************                                
 *                                                                             ************      ************                                  
 *                                                                           ************      ************                                    
 *                                                                         ************      ************                                      
 *                                                                       ************      ************                                        
 *                                                                     ************      ************                                          
 *                                                                   ************      ************                                            
 *                                                                 ************      ************                                              
 *                                                               ************      ************                                                
 *                                                             ************      ************                                                  
 *                                                           ************      ************                                                    
 *                                                         ************      ************                                                      
 *                                                       ************      ************                                                        
 *                                                     ************      ************                                                          
 *                                                   ************      ************                                                            
 *                                                 ************      ************                                                              
 *                                               ************      ************                                                                
 *                                             ************      ************                                                                  
 *                                           ************      ************                                                                    
 *                                         ************      ************                                                                      
 *                                       ************      ************                                                                        
 *                                     ************      ************                                                                          
 *                                   ************      ************                                                                            
 *                                 ************      ************                                                                              
 *                               ************      ************                                                                                
 *                             ************      ************                                                                                  
 *                           ************      ************                                                                                    
 *                         ************      ************                                                                                      
 *       ****************************      ************                                                                                        
 *     ****************************      ************                                                                                          
 *   ****************************      ************                                                                                            
 * ****************************      ************                                                                                              
 * 
 * 
 * 
 * ============================================================================================================================================
 * 
 */
#ifndef hAPI_H_TS_MessageQueue_H_
#define hAPI_H_TS_MessageQueue_H_
#include "./H_TS_Semaphore.h"




typedef struct{
  H_TS_Semaphore Semaphore;

  volatile Hsize ReadIndex;
  volatile Hsize WriteIndex;
  
  Hsize Count;
  Hsize ItemSize;
  volatile Hbyte* Mark;
  volatile Hbyte* Data;
}H_TS_MessageQueue;




/**
 * @brief 构造一个消息队列
 * @param MessageQueue 待构造的内存
 * @param Data 队列需要的缓冲区 大小(Count*ItemSize)
 * @param Mark 队列需要的缓冲区 大小Count
 * @param Count 队列容量 最小为2 最大只能容纳(Size-1)个项目
 * @param ItemSize 元素大小 最小为1
 * @return 无
 */
void H_TS_MessageQueue_Init(H_TS_MessageQueue* MessageQueue,Hbyte* Data,Hbyte* Mark,Hsize Count,Hsize ItemSize);

/**
 * @brief 析构一个消息队列
 * @param MessageQueue 待析构的消息队列
 * @return 目前实现只会返回0
 */
int H_TS_MessageQueue_Deinit(H_TS_MessageQueue* MessageQueue);

/**
 * @brief 新建消息队列
 * @param Size 队列容量 最小为2 最大只能容纳(Size-1)个元素
 * @return 队列对象 如果为NULL 则失败
 */
H_TS_MessageQueue* new_H_TS_MessageQueue(Hsize MessageQueue,Hsize ItemSize);

/**
 * @brief 删除消息队列
 * @param MessageQueue 待删除消息队列
 * @return 0:成功 -1:消息队列正在被其他线程占用
 */
int delete_H_H_TS_MessageQueue(H_TS_MessageQueue* MessageQueue);

/**
 * @brief 向消息队列添加元素 由中断调用
 * @param MessageQueue 待添加元素的消息队列
 * @param Message 不为NULL的待添加元素
 * @return 0:成功 其他:队列已满
 */
int H_TS_MessageQueue_TryPush_ISR(H_TS_MessageQueue* MessageQueue,void* Message);

/**
 * @brief 向消息队列添加元素
 * @param MessageQueue 待添加元素的消息队列
 * @param Message 不为NULL的待添加元素
 * @return 0:成功 其他:队列已满
 */
int H_TS_MessageQueue_TryPush(H_TS_MessageQueue* MessageQueue,void* Message);

/**
 * @brief 向消息队列添加元素
 * @param MessageQueue 待添加元素的消息队列
 * @param Message 不为NULL的待添加元素
 * @return 无
 */
void H_TS_MessageQueue_Push(H_TS_MessageQueue* MessageQueue,void* Message);

/**
 * @brief 向消息队列添加元素 时间限制
 * @param MessageQueue 待添加元素的消息队列
 * @param Message 不为NULL的待添加元素
 * @param Timeout 超时时间
 * @return 0:成功 其他:超时
 */
int H_TS_MessageQueue_Push_Time(H_TS_MessageQueue* MessageQueue,void* Message,H_TS_Tick Timeout);

/**
 * @brief 尝试从消息队列弹出元素
 * @param MessageQueue 待弹出元素的消息队列
 * @param Message 指向用于容纳元素的内存
 * @return 0:成功 其他:队列空
 */
int H_TS_MessageQueue_TryPop(H_TS_MessageQueue* MessageQueue,void* Message);

/**
 * @brief 从消息队列弹出元素
 * @param MessageQueue 待弹出元素的消息队列
 * @param Message 指向用于容纳元素的内存
 * @return 无
 */
void H_TS_MessageQueue_Pop(H_TS_MessageQueue* MessageQueue,void* Message);

/**
 * @brief 从消息队列弹出元素 时间限制
 * @param MessageQueue 待弹出元素的消息队列
 * @param Message 指向用于容纳元素的内存
 * @param Timeout 超时时间
 * @return 0:成功 其他:超时
 */
int H_TS_MessageQueue_Pop_Time(H_TS_MessageQueue* MessageQueue,void* Message,H_TS_Tick Timeout);




#endif //hAPI_H_TS_MessageQueue_H_
